chore(iota-transaction-builder): Add crate documentation #309
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was
linked to
issues
Oct 14, 2025
Thoralf-M
reviewed
Oct 14, 2025
Thoralf-M
reviewed
Oct 14, 2025
Thoralf-M
reviewed
Oct 14, 2025
Thoralf-M
approved these changes
Oct 14, 2025
Co-authored-by: Thibault Martinez <[email protected]>
|
I guess my suggestion was badly formatted |
Alex6323
reviewed
Oct 16, 2025
Comment on lines
99
to
101
| //! Each command method adds one or more commands to the final transaction. Some | ||
| //! commands have optional follow-up methods. All command results can be named | ||
| //! via [name](TransactionBuilder::name); |
There was a problem hiding this comment.
I would mention why naming a command is necessary because it's not apparent why that's a good feature to have?
Alex6323
reviewed
Oct 16, 2025
| //! - [transfer_objects](TransactionBuilder::transfer_objects): Send objects to | ||
| //! a recipient address. | ||
| //! - [publish](TransactionBuilder::publish): Publish a move package. | ||
| //! - `package_id`: Name the package ID returned by the publish call. |
There was a problem hiding this comment.
I was wondering what's that for, because I didn't need it in the example. 🤔
There was a problem hiding this comment.
It might not be needed
Alex6323
reviewed
Oct 16, 2025
Comment on lines
+147
to
+153
| //! - [apply_argument](TransactionBuilder::apply_argument) | ||
| //! - [apply_arguments](TransactionBuilder::apply_arguments) | ||
| //! - [input](TransactionBuilder::input) | ||
| //! - [pure_bytes](TransactionBuilder::pure_bytes) | ||
| //! - [pure](TransactionBuilder::pure) | ||
| //! - [command](TransactionBuilder::command) | ||
| //! - [named_command](TransactionBuilder::named_command) |
There was a problem hiding this comment.
but shouldn't they be documented here as well?
There was a problem hiding this comment.
I think it's better to have the detailed docs on the method itself and just link to them here
Alex6323
reviewed
Oct 20, 2025
|
Failing CI |
Co-authored-by: /alex/ <[email protected]>
…r/iota-rust-sdk into chore/txn-builder-docs
|
Failing CI (in case you haven't seen) |
Co-authored-by: Thibault Martinez <[email protected]>
|
Failing CI |
thibault-martinez
approved these changes
Oct 21, 2025
This was referenced Oct 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds docs to the
iota-transaction-buildercrate and thetransfer-objectsandgasbuilder functions.Closes #290
Closes #295
Closes #299